home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / apr_date.h.z / apr_date.h
C/C++ Source or Header  |  2002-07-08  |  6KB  |  149 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * Portions of this software are based upon public domain software
  55.  * originally written at the National Center for Supercomputing Applications,
  56.  * University of Illinois, Urbana-Champaign.
  57.  */
  58.  
  59. #ifndef APR_DATE_H
  60. #define APR_DATE_H
  61.  
  62. /**
  63.  * @file apr_date.h
  64.  * @brief APR-UTIL date routines
  65.  */
  66.  
  67. /**
  68.  * @defgroup APR_Util_Date Date routines
  69.  * @ingroup APR_Util
  70.  * @{
  71.  */
  72.  
  73. /*
  74.  * apr_date.h: prototypes for date parsing utility routines
  75.  */
  76.  
  77. #include "apu.h"
  78. #include "apr_time.h"
  79.  
  80. #ifdef __cplusplus
  81. extern "C" {
  82. #endif
  83.  
  84.  
  85. #define APR_DATE_BAD ((apr_time_t)0)
  86.  
  87. /**
  88.  * Compare a string to a mask
  89.  * @param data The string to compare
  90.  * @mask Mask characters (arbitrary maximum is 256 characters, just in case):
  91.  * <PRE>
  92.  *   @ - uppercase letter
  93.  *   $ - lowercase letter
  94.  *   & - hex digit
  95.  *   # - digit
  96.  *   ~ - digit or space
  97.  *   * - swallow remaining characters
  98.  *  <x> - exact match for any other character
  99.  * </PRE>
  100.  * @return 1 if the string matches, 0 otherwise
  101.  */
  102. APU_DECLARE(int) apr_date_checkmask(const char *data, const char *mask);
  103.  
  104. /**
  105.  * Parses an HTTP date in one of three standard forms:
  106.  * <PRE>
  107.  *     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
  108.  *     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
  109.  *     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
  110.  * </PRE>
  111.  * @param date The date in one of the three formats above
  112.  * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or
  113.  *         0 if this would be out of range or if the date is invalid.
  114.  */
  115. APU_DECLARE(apr_time_t) apr_date_parse_http(const char *date);
  116.  
  117. /**
  118.  * Parses a string resembling an RFC 822 date.  This is meant to be
  119.  * leinent in its parsing of dates.  Hence, this will parse a wider 
  120.  * range of dates than apr_date_parse_http.
  121.  *
  122.  * The prominent mailer (or poster, if mailer is unknown) that has
  123.  * been seen in the wild is included for the unknown formats.
  124.  * <PRE>
  125.  *     Sun, 06 Nov 1994 08:49:37 GMT  ; RFC 822, updated by RFC 1123
  126.  *     Sunday, 06-Nov-94 08:49:37 GMT ; RFC 850, obsoleted by RFC 1036
  127.  *     Sun Nov  6 08:49:37 1994       ; ANSI C's asctime() format
  128.  *     Sun, 6 Nov 1994 08:49:37 GMT   ; RFC 822, updated by RFC 1123
  129.  *     Sun, 06 Nov 94 08:49:37 GMT    ; RFC 822
  130.  *     Sun, 6 Nov 94 08:49:37 GMT     ; RFC 822
  131.  *     Sun, 06 Nov 94 08:49 GMT       ; Unknown [drtr@ast.cam.ac.uk] 
  132.  *     Sun, 6 Nov 94 08:49 GMT        ; Unknown [drtr@ast.cam.ac.uk]
  133.  *     Sun, 06 Nov 94 8:49:37 GMT     ; Unknown [Elm 70.85]
  134.  *     Sun, 6 Nov 94 8:49:37 GMT      ; Unknown [Elm 70.85] 
  135.  * </PRE>
  136.  *
  137.  * @param date The date in one of the formats above
  138.  * @return the apr_time_t number of microseconds since 1 Jan 1970 GMT, or
  139.  *         0 if this would be out of range or if the date is invalid.
  140.  */
  141. APU_DECLARE(apr_time_t) apr_date_parse_rfc(const char *date);
  142.  
  143. /** @} */
  144. #ifdef __cplusplus
  145. }
  146. #endif
  147.  
  148. #endif    /* !APR_DATE_H */
  149.